package com.atguigu.service.base.config;

import com.google.common.base.Predicates;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.function.Predicate;

/**
 * swagger2 配置类
 * 适用于 spring/springboot
 * 如果本配置类作为公共类使用，需要在 spring 的包扫描路径中包括此配置类所在位置。例如：@ComponentScan(basePackages = {"com.atguigu"})
 *
 * swagger2 常用注解：
 * @Api                 controller 类注解
 * @ApiOperation        controller 方法注解
 * @ApiParam            controller 方法参数注解
 * @ApiModel            model（entity、pojo）类注解
 * @ApiModelProperty    model 字段注解
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket webApiConfig() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("webApi")
                .apiInfo(webApiInfo())
                .select()
                .paths(Predicates.not(PathSelectors.regex("/admin/.*")))
                .paths(Predicates.not(PathSelectors.regex("/error.*")))
                .build();
    }

    private ApiInfo webApiInfo() {
        return new ApiInfoBuilder()
                .title("网站-课程中心API文档")
                .description("本文档描述了课程中心微服务接口定义")
                .version("1.9")
                .contact(new Contact("Helen", "http://atguigu.com", "alexzshl@126.com"))
                .build();
    }
}
